Skip to content

Updates instructions on the Get started page #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 8, 2024
Merged

Updates instructions on the Get started page #181

merged 2 commits into from
Nov 8, 2024

Conversation

kosabogi
Copy link
Contributor

@kosabogi kosabogi commented Nov 7, 2024

Overview

This PR updates the "Copy URL" section of the Elasticsearch -> Get Started page.

The related issue suggested the following wording:

  • At the top of the Overview page, click on "View" next to "Connection details."
  • Under the "Connection details" section, find the "Elasticsearch Endpoint" field.
  • Copy the URL for the Elasticsearch Endpoint, as you will use this URL to send all Elasticsearch API requests.

In the tutorial, we guide users through the Getting Started page of the Serverless deployment, not the Overview page, so I adjusted the instructions accordingly. Additionally, I clarified that these instructions should be followed on the Getting Started page of the deployment.

Related issue

#86

@kosabogi kosabogi requested a review from leemthompo November 7, 2024 08:58
@kosabogi kosabogi requested a review from a team as a code owner November 7, 2024 08:58
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 7, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@kosabogi kosabogi mentioned this pull request Nov 7, 2024
Closed
leemthompo
leemthompo approved these changes Nov 7, 2024
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! We don't need double asterisks in asciidoc for bold text, but that's independent of this PR :)

Not sure about the build fails though...

@kosabogi
Copy link
Contributor Author

kosabogi commented Nov 7, 2024

LGTM! We don't need double asterisks in asciidoc for bold text, but that's independent of this PR :)

Not sure about the build fails though...

Thanks for the review! I'm not sure about the failure either. I thought that the ci:doc-build label might be causing it (it caused issues with other PRs), but I didn’t add it here at all. @colleenmcginnis, could you possibly help us with this, please?

@leemthompo
Copy link
Contributor

I think this is on @colleenmcginnis's radar already 👍

@bmorelli25
Copy link
Member

run docs-build

@colleenmcginnis
Copy link
Contributor

🎉 Previews are working and all checks are passing!

@kosabogi kosabogi merged commit b9f4b24 into elastic:main Nov 8, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leemthompo leemthompo leemthompo approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kosabogi @leemthompo @bmorelli25 @colleenmcginnis